<?php

/*
 * Copyright 2008 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#namespace tehframework\routing;

interface Router
{
	/**
	 * @param  string $routeName
	 * @param  Route $route
	 * @return Router
	 */
	function connect($routeName, Route $route);
	
	/**
	 * @param  string $routeName
	 * @param  array<string,string> $args
	 * @param  array<string,mixed> $opts
	 * @param  Request? $request
	 * @return string
	 * @throws OutOfRangeException
	 */
	function build(
		$routeName,
		array $args = array(),
		array $opts = array(),
		Request $request = null);
	
	/**
	 * @param  Request $request
	 * @param  Response $response
	 * @return array<string>
	 */
	function route(Request $request, Response $response);
}